package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.CompanyApproSettingAddDTO;
import org.jsola.hr.query.CompanyApproSettingQuery;
import org.jsola.hr.vo.CompanyApproSettingListVO;
import org.jsola.hr.vo.CompanyApproSettingVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-公司审批开启设置")
public interface ICompanyApproSettingControllerAPI {

    /**
     * 新增公司审批开启设置
     * @param companyApproSettingAddDTO 公司审批开启设置新增实体
     * @return 公司审批开启设置展示对象
     */
    @ApiOperation(value = "新增公司审批开启设置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyApproSettingAddDTO", dataType = "CompanyApproSettingAddDTO", value = "新增公司审批开启设置", paramType = "body")
    })
    Result<CompanyApproSettingVO> save(CompanyApproSettingAddDTO companyApproSettingAddDTO);






    /**
     * 删除单个公司审批开启设置，彻底删除
     * @param companyApproSettingId 公司审批开启设置id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个公司审批开启设置，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyApproSettingId", dataType = "String", value = "公司审批开启设置id", paramType = "path")
    })
    Result<Integer> delete(String companyApproSettingId);


    /**
     * 批量删除公司审批开启设置，彻底删除
     * @param companyApproSettingIds 公司审批开启设置id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除公司审批开启设置，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyApproSettingIds", dataType = "String[]", value = "公司审批开启设置id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] companyApproSettingIds);


    /**
     * 根据公司审批开启设置id查询公司审批开启设置详情
     * @param companyApproSettingId 公司审批开启设置id
     * @return 公司审批开启设置详情
     */
    @ApiOperation(value="根据公司审批开启设置id查询公司审批开启设置详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyApproSettingId", dataType = "String", value = "公司审批开启设置id", paramType = "path")
    })
    Result<CompanyApproSettingVO> findById(String companyApproSettingId);


    /**
     * 查询公司审批开启设置
     * @param companyApproSettingQuery 公司审批开启设置查询参数
     * @return page
     */
    @ApiOperation(value="查询公司审批开启设置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyApproSettingQuery", dataType = "CompanyApproSettingQuery", value = "公司审批开启设置查询参数", paramType = "query")
    })
    Result<List<CompanyApproSettingListVO>> listAll(CompanyApproSettingQuery companyApproSettingQuery);


     /**
     * 分页查询公司审批开启设置
     * @param companyApproSettingQuery 公司审批开启设置查询参数
     * @return page
     */
    @ApiOperation(value="分页查询公司审批开启设置")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "companyApproSettingQuery", dataType = "CompanyApproSettingQuery", value = "公司审批开启设置查询参数", paramType = "query")
    })
    Result<Page<CompanyApproSettingListVO>> page(CompanyApproSettingQuery companyApproSettingQuery);


}

